CLI Syntax and Reference
The ePublisher AutoMap command-line interface can run a job, an ePublisher project, or a composition job (.wacj) that assembles independently deployed WebWorks Reverb 2.0 outputs into one site (see Federated Parcel Composition). The command-line interface uses the following syntax:
WebWorks.Automap.exe [-f] [-n] [-c] [-l] [-u] [-j] [-q] [-d directory] [--skip-reports]
[--deployscope=scope] [--deploysettings=file] [--destination=name] [--dryrun]
[{[-s directory] [-t targets] jobfile}|{[-t targets] projectfile}|{compositionjob}]The supported command-line options are defined in the following table.
Option | Description |
|---|---|
-c | Deletes cached information and builds the output from scratch. Use this option when passing an ePublisher project file ( |
-d directory | Specifies an alternate deployment directory. This setting overrides the specified default values. You can also specify this option as --deployfolder directory. |
-u | Scans all source documents for new styles, conditions, variables and xrefs. After the conversion is completed the resulting Express project file will be saved with all the updated information. You can also specify this option as |
-j | Just scans all source documents for new styles, conditions, variables and xrefs. Saves Express project file without running a conversion.You can also specify this option as |
-f | Does not send an email notification when this job is finished. This setting overrides the default value specified in the ePublisher AutoMap preferences. You can also specify this option as |
-l | Deletes all files in the deployment location before deploying the newly-generated output. This option ensures that all files in the deployment folder are from this last generation process. You can also specify this option as |
-n | Generates output and does not deploy it. This setting overrides the default deployment settings specified in the job or ePublisher project. You can also specify this option as |
-q | Suppresses the generation engine's step-by-step progress messages in the console and the job log. Milestone, warning, and error messages still print, and the per-target |
--skip-reports | Skips report generation during builds. Use this option to improve conversion times on large projects. Report pipelines will not execute, and no report files will be generated. |
--deployscope scope | Overrides the deploy scope declared on the target: |
--deploysettings file | Specifies an XML file of inline destination definitions (deploy preferences entry schema; Folder and Amazon S3 types only) overlaid onto the machine's deploy preferences by name. A job file's own inline definitions take precedence over entries from this file. |
--destination name | Deploys every built target to the named destination instead of the target's own. The name resolves like a declared destination: inline definitions first, then deploy preferences. Ignored when |
--dryrun | Forces every deployment in this run dry: Amazon S3 targets print their would-be upload, delete, and invalidation operations without contacting AWS, and transports without dry-run support skip their deployment. A composition job against a non-S3 destination skips its in-place compose, and a composition forwards this switch to the member jobs it builds. There is no opposite switch; a destination configured as dry run cannot be forced live. |
-s directory | Specifies the staging directory to use. Use this option only when passing a job |
-t targets | Builds only the specified targets. Separate multiple targets with a comma and no space on either side of the comma. Use this option when passing an ePublisher project file ( |
jobfile | Specifies the name of the ePublisher AutoMap |
project | Specifies the name of the ePublisher project file. Supports Express ( |
compositionjob | Specifies the name of an ePublisher AutoMap composition job ( |
As with other command-line applications, specify the command-line options on the command line after the application name itself. Separate multiple command-line options with a space. Review the following additional notes concerning ePublisher AutoMap command-line options:
The command-line options have both shortened and verbose formats. For example, you can specify the clean option as
–cor--clean. Both options mean exactly the same thing and you can mix the shortened and verbose formats across the options.Some options require additional information. For example, the staging folder option requires the name of the directory and is specified as --stagingdir directory. You need to include the equals sign without spaces on either side.
In cases where you specify paths with spaces, enclose those paths in double quotes to correctly handle the paths. You do not have to enclose paths without spaces in double quotes, but you can without an issue. For example,
C:\projectsworks without enclosing it in double-quotes. However,C:\my projectsdoes not work as expected. The correct format for the latter path is"C:\my projects".